<!doctype html>
<html class="no-js">
<head>
    <meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
    <title>CharacteristicWriteRequest</title>
<link href="../../../../images/logo-icon.svg" rel="icon" type="image/svg">    <script>var pathToRoot = "../../../../";</script>
    <script>document.documentElement.classList.replace("no-js","js");</script>
    <script>const storage = localStorage.getItem("dokka-dark-mode")
    if (storage == null) {
        const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
        if (osDarkSchemePreferred === true) {
            document.getElementsByTagName("html")[0].classList.add("theme-dark")
        }
    } else {
        const savedDarkMode = JSON.parse(storage)
        if(savedDarkMode === true) {
            document.getElementsByTagName("html")[0].classList.add("theme-dark")
        }
    }
    </script>
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async></script>
<script type="text/javascript" src="../../../../scripts/sourceset_dependencies.js" async></script>
<link href="../../../../styles/style.css" rel="Stylesheet">
<link href="../../../../styles/main.css" rel="Stylesheet">
<link href="../../../../styles/prism.css" rel="Stylesheet">
<link href="../../../../styles/logo-styles.css" rel="Stylesheet">
<link href="../../../../styles/font-jb-sans-auto.css" rel="Stylesheet">
<script type="text/javascript" src="../../../../scripts/clipboard.js" async></script>
<script type="text/javascript" src="../../../../scripts/navigation-loader.js" async></script>
<script type="text/javascript" src="../../../../scripts/platform-content-handler.js" async></script>
<script type="text/javascript" src="../../../../scripts/main.js" defer></script>
<script type="text/javascript" src="../../../../scripts/prism.js" async></script>
<script type="text/javascript" src="../../../../scripts/symbol-parameters-wrapper_deferred.js" defer></script></head>
<body>
    <div class="root">
<nav class="navigation" id="navigation-wrapper">
    <div class="navigation--inner">
        <div class="navigation-title">
            <button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
            <div class="library-name">
<a class="library-name--link" href="../../../../index.html">
                            Kotlin-BLE-Library
                    </a>            </div>
            <div class="library-version">
            </div>
        </div>
        <div class="filter-section" id="filter-section">
                <button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":server-api:dokkaHtmlPartial/release">androidJvm</button>
        </div>
    </div>
    <div class="navigation-controls">
        <button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
        <div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
    </div>
</nav>
        <div id="container">
            <div class="sidebar" id="leftColumn">
                <div class="sidebar--inner" id="sideMenu"></div>
            </div>
            <div id="main">
<div class="main-content" data-page-type="classlike" id="content" pageids="server-api::no.nordicsemi.android.kotlin.ble.server.api/ServerGattEvent.CharacteristicWriteRequest///PointingToDeclaration//-1523335293">
  <div class="breadcrumbs"><a href="../../../index.html">server-api</a><span class="delimiter">/</span><a href="../../index.html">no.nordicsemi.android.kotlin.ble.server.api</a><span class="delimiter">/</span><a href="../index.html">ServerGattEvent</a><span class="delimiter">/</span><span class="current">CharacteristicWriteRequest</span></div>
  <div class="cover ">
    <h1 class="cover"><span>Characteristic</span><wbr><span>Write</span><wbr><span><span>Request</span></span></h1>
    <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":server-api:dokkaHtmlPartial/release"><div class="symbol monospace"><span class="token keyword">data </span><span class="token keyword">class </span><a href="index.html">CharacteristicWriteRequest</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">val </span>device<span class="token operator">: </span><a href="../../../../core/no.nordicsemi.android.kotlin.ble.core/-client-device/index.html">ClientDevice</a><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">val </span>requestId<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">val </span>characteristic<span class="token operator">: </span><a href="../../../../core/no.nordicsemi.android.kotlin.ble.core.wrapper/-i-bluetooth-gatt-characteristic/index.html">IBluetoothGattCharacteristic</a><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">val </span>preparedWrite<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">val </span>responseNeeded<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">val </span>offset<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">val </span>value<span class="token operator">: </span><a href="../../../../core/no.nordicsemi.android.kotlin.ble.core.data.util/-data-byte-array/index.html">DataByteArray</a></span></span><span class="token punctuation">)</span> : <a href="../-characteristic-event/index.html">ServerGattEvent.CharacteristicEvent</a></div><p class="paragraph">A remote client has requested to write to a local characteristic.</p><p class="paragraph">An application must call <a href="../../-gatt-server-a-p-i/send-response.html">GattServerAPI.sendResponse</a> to complete the request.</p><h4 class="">See also</h4><div class="table"><div class="table-row" data-filterable-current=":server-api:dokkaHtmlPartial/release" data-filterable-set=":server-api:dokkaHtmlPartial/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="https://developer.android.com/reference/kotlin/android/bluetooth/BluetoothGattServerCallback.html#oncharacteristicwriterequest"><span>Bluetooth</span><wbr><span>Gatt</span><wbr><span>Server</span><wbr><span>Callback.</span><wbr><span>on</span><wbr><span>Characteristic</span><wbr><span>Write</span><wbr><span><span>Request</span></span></a></div></span></div><div><div class="title"><p class="paragraph">(https://developer.android.com/reference/android/bluetooth/BluetoothGattServerCallback#onCharacteristicWriteRequest(android.bluetooth.BluetoothDevice,%20int,%20android.bluetooth.BluetoothGattCharacteristic,%20boolean,%20boolean,%20int,%20byte[]))</p></div></div></div></div></div></div></div>
  </div>
  <div class="tabbedcontent">
    <div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="CONSTRUCTOR,TYPE,PROPERTY,FUNCTION">Members</button></div>
    <div class="tabs-section-body">
      <div data-togglable="CONSTRUCTOR">
        <h2 class="">Constructors</h2>
        <div class="table"><a data-name="-252716851%2FConstructors%2F-1523335293" anchor-label="CharacteristicWriteRequest" id="-252716851%2FConstructors%2F-1523335293" data-filterable-set=":server-api:dokkaHtmlPartial/release"></a>
          <div class="table-row" data-togglable="CONSTRUCTOR" data-filterable-current=":server-api:dokkaHtmlPartial/release" data-filterable-set=":server-api:dokkaHtmlPartial/release">
            <div class="main-subrow keyValue ">
              <div class=""><span class="inline-flex">
                  <div><a href="-characteristic-write-request.html"><span>Characteristic</span><wbr><span>Write</span><wbr><span><span>Request</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-252716851%2FConstructors%2F-1523335293"></span>
                    <div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
                  </span></span></div>
              <div>
                <div class="title">
                  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":server-api:dokkaHtmlPartial/release"><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">device<span class="token operator">: </span><a href="../../../../core/no.nordicsemi.android.kotlin.ble.core/-client-device/index.html">ClientDevice</a><span class="token punctuation">, </span></span><span class="parameter ">requestId<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a><span class="token punctuation">, </span></span><span class="parameter ">characteristic<span class="token operator">: </span><a href="../../../../core/no.nordicsemi.android.kotlin.ble.core.wrapper/-i-bluetooth-gatt-characteristic/index.html">IBluetoothGattCharacteristic</a><span class="token punctuation">, </span></span><span class="parameter ">preparedWrite<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token punctuation">, </span></span><span class="parameter ">responseNeeded<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token punctuation">, </span></span><span class="parameter ">offset<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a><span class="token punctuation">, </span></span><span class="parameter ">value<span class="token operator">: </span><a href="../../../../core/no.nordicsemi.android.kotlin.ble.core.data.util/-data-byte-array/index.html">DataByteArray</a></span></span><span class="token punctuation">)</span></div></div></div>
                </div>
              </div>
            </div>
          </div>
        </div>
      </div>
      <div data-togglable="PROPERTY">
        <h2 class="">Properties</h2>
        <div class="table"><a data-name="147994100%2FProperties%2F-1523335293" anchor-label="characteristic" id="147994100%2FProperties%2F-1523335293" data-filterable-set=":server-api:dokkaHtmlPartial/release"></a>
          <div class="table-row" data-filterable-current=":server-api:dokkaHtmlPartial/release" data-filterable-set=":server-api:dokkaHtmlPartial/release">
            <div class="main-subrow keyValue ">
              <div class=""><span class="inline-flex">
                  <div><a href="characteristic.html"><span><span>characteristic</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="147994100%2FProperties%2F-1523335293"></span>
                    <div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
                  </span></span></div>
              <div>
                <div class="title">
                  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":server-api:dokkaHtmlPartial/release"><div class="symbol monospace"><span class="token keyword">val </span><a href="characteristic.html">characteristic</a><span class="token operator">: </span><a href="../../../../core/no.nordicsemi.android.kotlin.ble.core.wrapper/-i-bluetooth-gatt-characteristic/index.html">IBluetoothGattCharacteristic</a></div><div class="brief "><p class="paragraph">Characteristic to be written to.</p></div></div></div>
                </div>
              </div>
            </div>
          </div>
<a data-name="663446425%2FProperties%2F-1523335293" anchor-label="device" id="663446425%2FProperties%2F-1523335293" data-filterable-set=":server-api:dokkaHtmlPartial/release"></a>
          <div class="table-row" data-filterable-current=":server-api:dokkaHtmlPartial/release" data-filterable-set=":server-api:dokkaHtmlPartial/release">
            <div class="main-subrow keyValue ">
              <div class=""><span class="inline-flex">
                  <div><a href="device.html"><span><span>device</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="663446425%2FProperties%2F-1523335293"></span>
                    <div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
                  </span></span></div>
              <div>
                <div class="title">
                  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":server-api:dokkaHtmlPartial/release"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">override </span><span class="token keyword">val </span><a href="device.html">device</a><span class="token operator">: </span><a href="../../../../core/no.nordicsemi.android.kotlin.ble.core/-client-device/index.html">ClientDevice</a></div><div class="brief "><p class="paragraph">The remote device that has requested the write operation.</p></div></div></div>
                </div>
              </div>
            </div>
          </div>
<a data-name="1875028988%2FProperties%2F-1523335293" anchor-label="offset" id="1875028988%2FProperties%2F-1523335293" data-filterable-set=":server-api:dokkaHtmlPartial/release"></a>
          <div class="table-row" data-filterable-current=":server-api:dokkaHtmlPartial/release" data-filterable-set=":server-api:dokkaHtmlPartial/release">
            <div class="main-subrow keyValue ">
              <div class=""><span class="inline-flex">
                  <div><a href="offset.html"><span><span>offset</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1875028988%2FProperties%2F-1523335293"></span>
                    <div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
                  </span></span></div>
              <div>
                <div class="title">
                  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":server-api:dokkaHtmlPartial/release"><div class="symbol monospace"><span class="token keyword">val </span><a href="offset.html">offset</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></div><div class="brief "><p class="paragraph">The offset given for the value.</p></div></div></div>
                </div>
              </div>
            </div>
          </div>
<a data-name="855971497%2FProperties%2F-1523335293" anchor-label="preparedWrite" id="855971497%2FProperties%2F-1523335293" data-filterable-set=":server-api:dokkaHtmlPartial/release"></a>
          <div class="table-row" data-filterable-current=":server-api:dokkaHtmlPartial/release" data-filterable-set=":server-api:dokkaHtmlPartial/release">
            <div class="main-subrow keyValue ">
              <div class=""><span class="inline-flex">
                  <div><a href="prepared-write.html"><span>prepared</span><wbr><span><span>Write</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="855971497%2FProperties%2F-1523335293"></span>
                    <div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
                  </span></span></div>
              <div>
                <div class="title">
                  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":server-api:dokkaHtmlPartial/release"><div class="symbol monospace"><span class="token keyword">val </span><a href="prepared-write.html">preparedWrite</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></div><div class="brief "><p class="paragraph">True, if this write operation should be queued for later execution.</p></div></div></div>
                </div>
              </div>
            </div>
          </div>
<a data-name="1336004673%2FProperties%2F-1523335293" anchor-label="requestId" id="1336004673%2FProperties%2F-1523335293" data-filterable-set=":server-api:dokkaHtmlPartial/release"></a>
          <div class="table-row" data-filterable-current=":server-api:dokkaHtmlPartial/release" data-filterable-set=":server-api:dokkaHtmlPartial/release">
            <div class="main-subrow keyValue ">
              <div class=""><span class="inline-flex">
                  <div><a href="request-id.html"><span>request</span><wbr><span><span>Id</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1336004673%2FProperties%2F-1523335293"></span>
                    <div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
                  </span></span></div>
              <div>
                <div class="title">
                  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":server-api:dokkaHtmlPartial/release"><div class="symbol monospace"><span class="token keyword">val </span><a href="request-id.html">requestId</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></div><div class="brief "><p class="paragraph">The Id of the request.</p></div></div></div>
                </div>
              </div>
            </div>
          </div>
<a data-name="-1051804519%2FProperties%2F-1523335293" anchor-label="responseNeeded" id="-1051804519%2FProperties%2F-1523335293" data-filterable-set=":server-api:dokkaHtmlPartial/release"></a>
          <div class="table-row" data-filterable-current=":server-api:dokkaHtmlPartial/release" data-filterable-set=":server-api:dokkaHtmlPartial/release">
            <div class="main-subrow keyValue ">
              <div class=""><span class="inline-flex">
                  <div><a href="response-needed.html"><span>response</span><wbr><span><span>Needed</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1051804519%2FProperties%2F-1523335293"></span>
                    <div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
                  </span></span></div>
              <div>
                <div class="title">
                  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":server-api:dokkaHtmlPartial/release"><div class="symbol monospace"><span class="token keyword">val </span><a href="response-needed.html">responseNeeded</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></div><div class="brief "><p class="paragraph">True, if the remote device requires a response.</p></div></div></div>
                </div>
              </div>
            </div>
          </div>
<a data-name="204061626%2FProperties%2F-1523335293" anchor-label="value" id="204061626%2FProperties%2F-1523335293" data-filterable-set=":server-api:dokkaHtmlPartial/release"></a>
          <div class="table-row" data-filterable-current=":server-api:dokkaHtmlPartial/release" data-filterable-set=":server-api:dokkaHtmlPartial/release">
            <div class="main-subrow keyValue ">
              <div class=""><span class="inline-flex">
                  <div><a href="value.html"><span><span>value</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="204061626%2FProperties%2F-1523335293"></span>
                    <div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
                  </span></span></div>
              <div>
                <div class="title">
                  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":server-api:dokkaHtmlPartial/release"><div class="symbol monospace"><span class="token keyword">val </span><a href="value.html">value</a><span class="token operator">: </span><a href="../../../../core/no.nordicsemi.android.kotlin.ble.core.data.util/-data-byte-array/index.html">DataByteArray</a></div><div class="brief "><p class="paragraph">The value the client wants to assign to the characteristic.</p></div></div></div>
                </div>
              </div>
            </div>
          </div>
        </div>
      </div>
    </div>
  </div>
</div>
      <div class="footer">
        <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
      </div>
            </div>
        </div>
    </div>
</body>
</html>

